Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sample docs #35

Merged
merged 1 commit into from
Jan 13, 2025
Merged

Add sample docs #35

merged 1 commit into from
Jan 13, 2025

Conversation

krish2718
Copy link
Contributor

@krish2718 krish2718 commented Jan 9, 2025

Add sample documentation to main docs.

@krish2718 krish2718 force-pushed the add_sample_docs branch 3 times, most recently from 9675203 to 4e4055a Compare January 9, 2025 19:47
@krish2718
Copy link
Contributor Author

krish2718 commented Jan 9, 2025

@sachinthegreen this works, but the RST files are copied from NCS and rely on NCS custom sphinx extensions, we have below choices:

  1. Fork from NCS and remove NCS custom extensions reliance and instead replace those texts manually. This approach has Duplicate maintenance effort.
  2. Clone sdk-nrf (it was removed recently from the manifest) and get those extensions work, which needs significant effort as it needs combining two sphinx projects.
  3. Remove all RST files from samples and instead point to NCS docs (URLs).

WDYT?

@sachinthegreen
Copy link

@sachinthegreen this works, but the RST files are copied from NCS and rely on NCS custom sphinx extensions, we have below choices:

  1. Fork from NCS and remove NCS custom extensions reliance and instead replace those texts manually. This approach has Duplicate maintenance effort.
  2. Clone sdk-nrf (it was removed recently from the manifest) and get those extensions work, which needs significant effort as it needs combining two sphinx projects.
  3. Remove all RST files from samples and instead point to NCS docs (URLs).

WDYT?

My preference would be 3.

Remove the NCS RST files they won't render properly, instead just add
links to the NCS docs, they should be applicable for BM too.

Signed-off-by: Chaitanya Tata <[email protected]>
@krish2718
Copy link
Contributor Author

@sachinthegreen this works, but the RST files are copied from NCS and rely on NCS custom sphinx extensions, we have below choices:

  1. Fork from NCS and remove NCS custom extensions reliance and instead replace those texts manually. This approach has Duplicate maintenance effort.
  2. Clone sdk-nrf (it was removed recently from the manifest) and get those extensions work, which needs significant effort as it needs combining two sphinx projects.
  3. Remove all RST files from samples and instead point to NCS docs (URLs).

WDYT?

My preference would be 3.

done.

@krish2718 krish2718 merged commit 3e0b29f into nrfconnect:main Jan 13, 2025
2 checks passed
@krish2718 krish2718 deleted the add_sample_docs branch January 13, 2025 09:52
@ioannisg
Copy link
Contributor

A bit late for this review @sachinthegreen and @krish2718 , but i would also go for option 3. My only concern is what if we ever deviate the BM samples from the main NCS with respect to sample code - how we can address that in terms of docs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants